home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / util / sys / StringSnip.lha / StringSnip / StringSnip.readme < prev    next >
Encoding:
Text File  |  2000-09-10  |  10.6 KB  |  321 lines
  1. Short:    Much better editing features in string gadgets
  2. Uploader: thor@math.tu-berlin.de
  3. Author:   thor@math.tu-berlin.de (Thomas Richter)
  4. Type:     util/sys
  5. Version:  2.05
  6. Requires: Os 2.05, optionally ViNCEd.
  7. _____________________________________________________________________________
  8.  
  9. New in release 2.05:
  10.  
  11.     - The possible TAB expansions are now sorted alphabetically.
  12.     - Note that in case you want both the functions "Insert 
  13.       Clipboard" and "Replace by Clipboard", the keyboard strings
  14.       PASTE=RAmiga v and PASTE=RAmiga V must be defined *both* and
  15.       must be defined to both the same ViNCEd function.
  16.  
  17. New in release 2.04:
  18.  
  19.     - Due to some unfortune, an internal structure appeared on an odd
  20.       address which caused a crash on 68000 and 68010 based systems.
  21.       Nothing else changed.
  22.  
  23. New in release 2.03:
  24.  
  25.     - Fixed a possible incompatibility of Amiga-V that could have
  26.       resulted in inserting a string twice if the application edit
  27.       hook is able to parse this key as well.
  28.  
  29. New in release 2.02:
  30.  
  31.     - The NumLock function was erraneously bound to Alt-Ü on german
  32.       keyboards. Never thrust a Data-Becker book, especially when
  33.       looking up key-codes.
  34.  
  35. New in release 2.01.1:
  36.  
  37.     - Included a sample preferences file for those people that don't
  38.       read ReadMes. (-;
  39.  
  40. New in release 2.01:
  41.  
  42.     - Almost a complete rewrite, fully configurable with ViNCEd style
  43.       preferences (vnc.library required).
  44.     - Includes now TAB expansions and much more editor commands.
  45. _____________________________________________________________________________
  46.  
  47.  
  48. The following table shows the default configuration for string gadget hooks:
  49.  
  50. Alt+Cursor keys:    Move to beginning of next/previous word
  51. Alt+Ctrl+Cursor keys:    Move to beginning of next/previous path component
  52. Shift+Cursor keys:    Move to start/end of the contents.
  53. Alt+Cursor keys:    ditto.
  54. Alt+Del:        Clear the contents.
  55. Shift+Del:        ditto.
  56. ALT+Backspace:        Erase to the beginning of the word under the cursor
  57. Shift+Alt+Del:        Erase text behind the cursor
  58. Shift+Alt+BS:        Erase text before the cursor position
  59. Amiga+X:        Cut the contents of the gadget to the clipboard
  60. Amiga+C:        Copy the contents to the clipboard
  61. Amiga+V:        Insert the clipboard contents into the gadget
  62. Shift+Amiga+V:        Replace the string gadget contents by the clipboard
  63. Aniga+Q:        Undo-operation
  64. Ctrl+Tab:        TAB expansion
  65. Ctrl+Shift+Tab:        TAB expansion backwards
  66. Commodore-key:        Turn off the extended editing features temporary
  67.  
  68.  
  69. The configuration is, however, fully adjustable with the SetVNC program
  70. of the "ViNCEd" package, see below for details.
  71.  
  72. The TAB expansion is a "cut down" version of the ViNCEd style expansion
  73. mechanism without a double-TAB requester, without the complete command
  74. path search and without a TAB expansion cache.
  75. Please note that string gadget does not come with a "natural" directory the 
  76. TAB expansion should search in, hence the path to be expanded must be either
  77. absolute or relative to the boot volume, i.e. SYS:
  78.  
  79. (This file is actually a part of the ViNCEd distribution. See 
  80. util/shell/ViNCEd.lha for the complete archive).
  81.  
  82.  
  83. Installation:
  84.     Copy to your C: drawer.
  85.  
  86.     StringSnip install    To install the extended editing features
  87.     StringSnip remove    To remove it again.
  88.  
  89. Additionally:    
  90.     Copy the demo prefs file below to ENVARC:StringSnip.prefs and 
  91.     add the line
  92.  
  93.     StringSnip PREFS ENV:StringSnip.prefs INSTALL
  94. _____________________________________________________________________________
  95.  
  96. Extended options, full synopsis:
  97.  
  98. StringSnip INSTALL/S,REMOVE/S,PREFS/K,HELP/S
  99.  
  100.  
  101. INSTALL/S            Installs the enhanced string edit hook
  102.                 or replaces a previously installed 
  103.                 "StringSnip" copy.
  104.                 This is the default operation.
  105.  
  106. REMOVE/S            Remove the StringSnip hook.
  107.  
  108. PREFS/K                Specifies a file name where the preferences
  109.                 should be taken from. This is a text based
  110.                 ViNCEd-compatible preferences file. It
  111.                 should be created by the "SetVNC" program
  112.                 and should be placed somehwere in the ENV:
  113.                 drawer.
  114.                 THIS OPTION REQUIRES the vnc.library, i.e.
  115.                 ViNCEd must have been installed.
  116.  
  117. HELP/S                Prints a tiny overview about the command line
  118.                 options.
  119. _____________________________________________________________________________
  120.  
  121. The preferences file: 
  122.  
  123. It is recommended that you use the "SetVNC" program of the ViNCEd package
  124. to generate this file, as the vnc.library is required anyways to read it.
  125.  
  126. As last resort, an ASCII editor is enough to edit this file, though.
  127.  
  128. The file is a listing of options, followed by an "=" ("equals") sign,
  129. followed by the value you want to set the option to. This must be "on"
  130. or "off" for boolean options, a number for numerical or a key specification
  131. for the keyboard configuration options. Commands must be introduced by a
  132. semicolon.
  133.  
  134. Here's a list of the options that are meaningfull to StringSnip. The lines
  135. below could be cut out and written directly to a file, for example to
  136. ENVARC:StringSnip.prefs.
  137.  
  138. ___________cut here__________________________________________________________
  139.  
  140. WRAP=off        
  141. ;whether the TAB expansion wraps around or not.
  142.  
  143. ;TAB expansion settings:
  144. ;These are priorities how the list of found nodes are sorted and in
  145. ;which order they appear. The list of found matches can be cycled thru
  146. ;with the TAB expansion keys, as in ViNCEd.
  147.  
  148. TAB_FILE_PRI=0        
  149. ;priority of non-executable non-script files
  150. TAB_EXEC_PRI=2        
  151. ;priority of executables.
  152. TAB_SCRIPT_PRI=1    
  153. ;priority of script files.
  154. TAB_INFO_PRI=-10    
  155. ;priority of icons
  156. TAB_DEVICE_PRI=-2    
  157. ;of devices
  158. TAB_ASSIGN_PRI=-2    
  159. ;of assigns (logical devices)
  160. TAB_VOLUME_PRI=-2    
  161. ;of volume names
  162. TAB_DIRECTORY_PRI=3    
  163. ;of directories
  164. TAB_FULLEXPAND=off    
  165. ;should the first TAB expand the file completely?
  166.  
  167.  
  168. ;Keyboard:
  169. ;These are one or more qualifiers, i.e.
  170. ; Alt, Shift for either shift or alt key, RAmiga, LAmiga, RShift, LShift,
  171. ; RAlt, RAlt for the right/left modifier keys, "Num" if numlock is "on".
  172. ; The numlock is a special modifier that is toggled by an additional key
  173. ; to be set up here, it is completely unrelated to the "numeric keypad"
  174. ;and a key name, as "Left" "Right" for the cursor keys or
  175. ;a keyboard code, or an ASCII value enclosed in single quotes if the
  176. ;key should be matched on an ASCII string and not on a physical key.
  177. ;Details about this again in the ViNCEd guide.
  178. ;
  179. CURSOR_LEFT=Left
  180. CURSOR_RIGHT=Right        
  181. ;guess what...
  182. HALF_SCREEN_LEFT=Shift Left    
  183. ;moves one string gadget width
  184. HALF_SCREEN_RIGHT=Shift Right    
  185. ;to the left/right (not used by default)
  186. TO_LEFT_BORDER=Ctrl Left
  187. TO_RIGHT_BORDER=Ctrl Right    
  188. ;moves to the boundary
  189. PREV_WORD=Alt Left
  190. NEXT_WORD=Alt Right        
  191. ;moves word-wise
  192. PREV_COMPONENT=Ctrl Alt Left
  193. NEXT_COMPONENT=Ctrl Alt Right    
  194. ;moves path-component-wise
  195. CURSOR_LEFT=Num Num4
  196. CURSOR_RIGHT=Num Num6        
  197. ;more than one definition is allowed!
  198. TO_LEFT_BORDER=Ctrl Left
  199. TO_RIGHT_BORDER=Ctrl Right
  200. SEND_INPUTS=Return        
  201. ;completes the input
  202. INSERT_^J=Shift Alt Return    
  203. ;inserts a Ctrl-J.
  204. TAB_FORWARDS=Tab
  205. TAB_BACKWARDS=Shift Tab        
  206. ;TAB cycling
  207. EXPAND_PATH=Ctrl Tab
  208. EXPAND_BACKWARDS=Ctrl Shift Tab    
  209. ;TAB expansion
  210. DELETE_FORWARDS=Del        
  211. ;the "Delete" function
  212. DELETE_BACKWARDS=Backspace    
  213. ;the "Backspace" function
  214. DELETE_FULL_LINE=Shift Del    
  215. ;delete all
  216. DELETE_WORD_FWDS=Shift Backspace
  217. DELETE_WORD_BKWDS=Alt Backspace    
  218. ;one word, backwards
  219. DELETE_COMPONENT_FWDS=Ctrl Alt Del
  220. DELETE_COMPONENT_BKWDS=Ctrl Alt Backspace
  221. DELETE_END_OF_LINE=Shift Alt Del
  222. DELETE_START_OF_LINE=Shift Alt Backspace
  223. ;the next are the standard clipboard functions
  224. CUT=RAmiga x            
  225. COPY=RAmiga c
  226. PASTE=RAmiga v
  227. TOGGLE_NUMLOCK=Alt Num[        
  228. ;Num[ is the '[' key on the numpad, this toggles the NumLock qualifier.
  229. YANK=RAmiga q            
  230. ;this is the intuition style "undo"
  231. HELP=Help            
  232. ;the HELP function, if used by the program
  233. INSERT_CSI=Alt Esc        
  234. ;inserts 0x9B
  235. INSERT_ESC=Shift Esc        
  236. ;inserts 0x1B
  237.  
  238. _____________________________________________________________________________
  239.  
  240.                          The THOR-Software Licence (v2, 24th June 1998)
  241.  
  242.  
  243. This License applies to the computer program known as "StringSnip".
  244. The "Program", below, refers to such program. The "Archive" refers to the 
  245. package of distribution, as prepared by the author of the Program, 
  246. Thomas Richter. Each licensee is addressed as "you".
  247.  
  248.  
  249.  
  250. The Program and the data in the archive are freely distributable
  251. under the restrictions stated below, but are also Copyright (c)
  252. Thomas Richter.
  253.  
  254. Distribution of the Program, the Archive and the data in the Archive by a
  255. commercial organization without written permission from the author to any
  256. third party is prohibited if any payment is made in connection with such
  257. distribution, whether directly (as in payment for a copy of the Program) or
  258. indirectly (as in payment for some service related to the Program, or
  259. payment for some product or service that includes a copy of the Program
  260. "without charge"; these are only examples, and not an exhaustive enumeration
  261. of prohibited activities).
  262.  
  263.  
  264. However, the following methods of distribution
  265. involving payment shall not in and of themselves be a violation of this
  266. restriction:
  267.  
  268.  
  269. (i) Posting the Program on a public access information storage and
  270. retrieval service for which a fee is received for retrieving information
  271. (such as an on-line service), provided that the fee is not
  272. content-dependent (i.e., the fee would be the same for retrieving the same
  273. volume of information consisting of random data).
  274.  
  275.  
  276. (ii) Distributing the Program on a CD-ROM, provided that
  277.  
  278. a) the Archive is reproduced entirely and verbatim on such CD-ROM, including
  279. especially this licence agreement;
  280.  
  281. b) the CD-ROM is made available to the public for a nominal fee only,
  282.  
  283. c) a copy of the CD is made available to the author for free except for
  284. shipment costs, and
  285.  
  286. d) provided further that all information on such CD-ROM is redistributable
  287. for non-commercial purposes without charge.
  288.  
  289.  
  290. Redistribution of a modified version of the Archive, the Program or the
  291. contents of the Archive is prohibited in any way, by any organization,
  292. regardless whether commercial or non-commercial. Everything must be kept
  293. together, in original and unmodified form.
  294.  
  295.  
  296.  
  297.  
  298. Limitations.
  299.  
  300.  
  301. THE PROGRAM IS PROVIDED TO YOU "AS IS", WITHOUT WARRANTY. THERE IS NO
  302. WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  303. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  304. PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
  305. RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
  306. THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  307. SERVICING, REPAIR OR CORRECTION.
  308.  
  309.  
  310. IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE THE PROGRAM, THE ARCHIVE
  311. AND ALL DATA OF THIS ARCHIVE FROM YOUR STORAGE SYSTEM. YOU ACCEPT THIS
  312. LICENCE BY USING OR REDISTRIBUTING THE PROGRAM.
  313.  
  314.  
  315.                                                         Thomas Richter
  316.  
  317. _____________________________________________________________________________
  318.  
  319. Thomas,
  320.     September 2000
  321.